---

deFileSystem Class Reference

#include <deFileSystem_priv.hpp>

Inheritance diagram for deFileSystem:

[legend]Collaboration diagram for deFileSystem:

[legend]List of all members.

Public Member Functions
void *	GetInterface (IdeFileSystem::interface_t i)
virtual IdeFile *	Open (const char *Filename, long OpenFlags)
virtual const char *	GetDirectory ()
	Get the current directoriy.
virtual deBoolean	SetDirectory (const char *Directory)
	Set the current directory.
virtual deBoolean	Rename (const char *OldFilename, const char *NewFilename)
virtual deBoolean	Delete (const char *Filename, deFSPROGRESS StatusCallback)
virtual deBoolean	Move (const char *OldFilename, const char *NewFilename, deFSPROGRESS StatusCallback)
virtual deBoolean	Copy (const char *OldFilename, const char *NewFilename, deFSPROGRESS StatusCallback)
virtual deBoolean	AddDirectory (const char *Directory)
virtual deBoolean	DeleteDirectory (const char *Directory, deFSPROGRESS StatusCallback)
void *	FindFirst (const char *Pattern, deFileProperties *Properties)
deBoolean	FindNext (void *Handle, deFileProperties *Properties)
deBoolean	FindEnd (void *Handle)
Protected Member Functions
	deFileSystem ()
virtual	~deFileSystem ()

---

Constructor & Destructor Documentation

deFileSystem::deFileSystem (    )  [protected]

deFileSystem::~deFileSystem (    )  [protected, virtual]

---

Member Function Documentation

deBoolean deFileSystem::AddDirectory (  const char *    Directory )  [virtual]

Create a directory Parameters: in]  Directory The name of the directory Implements IdeFileSystem. Reimplemented in deFSReal, and deFSVirtual.

deBoolean deFileSystem::Copy (  const char *    OldFilename, const char *    NewFilename, deFSPROGRESS    StatusCallback )  [virtual]

Copy a file Parameters: in]  Filename File to copy in]  StatusCallback Pointer to a function to call while copying, pass a NULL for no callbacks Returns: True/False if the copy was successful Implements IdeFileSystem. Reimplemented in deFSReal, and deFSVirtual.

deBoolean deFileSystem::Delete (  const char *    Filename, deFSPROGRESS    StatusCallback )  [virtual]

Delete a file Parameters: in]  Filename File to Delete in]  StatusCallback Pointer to a function to call while deleting, pass a NULL for no callbacks Returns: True/False if the delete was successful Implements IdeFileSystem. Reimplemented in deFSReal, and deFSVirtual.

deBoolean deFileSystem::DeleteDirectory (  const char *    Directory, deFSPROGRESS    StatusCallback )  [virtual]

Delete a directory Parameters: in]  Name of the directory to delete in]  StatusCallback Pointer to a function to call while deleting, pass a NULL for no callbacks Returns: True/False if the delete was successful Implements IdeFileSystem. Reimplemented in deFSReal, and deFSVirtual.

deBoolean deFileSystem::FindEnd (  void *    Handle )  [virtual]

Finish a find and cleanup any memory usage Parameters: in]  Handle Find to finish Returns: True if the find is done, False if there was a problem Implements IdeFileSystem. Reimplemented in deFSReal, and deFSVirtual.

void * deFileSystem::FindFirst (  const char *    Pattern, deFileProperties *    Properties )  [virtual]

Start a find on the filesystem Parameters: in]  Pattern Pattern to match the files to. ? to match 1 character, * for multiple character matching out]  Properties Information about the first file found that matches Returns: A value used to identify the find for later finds Implements IdeFileSystem. Reimplemented in deFSReal, and deFSVirtual.

deBoolean deFileSystem::FindNext (  void *    Handle, deFileProperties *    Properties )  [virtual]

Find the next file in the list that matches Parameters: in]  Handle Value returned by FindFirst out]  Properties Information about the file found that matches Returns: True if a file was found, False if no more files exist Implements IdeFileSystem. Reimplemented in deFSReal, and deFSVirtual.

const char * deFileSystem::GetDirectory (    )  [virtual]

Get the current directoriy. Implements IdeFileSystem. Reimplemented in deFSReal, and deFSVirtual.

void* deFileSystem::GetInterface (  IdeFileSystem::interface_t    i )  [virtual]

Function to obtain the proper interface for the filesystem Parameters: in]  i Input for the type of interface to return Returns: Returns a pointer to the requested interface or NULL if an invalid interface Implements IdeFileSystem. Reimplemented in deFSReal, and deFSVirtual.

deBoolean deFileSystem::Move (  const char *    OldFilename, const char *    NewFilename, deFSPROGRESS    StatusCallback )  [virtual]

Move a file Parameters: in]  Filename File to move in]  StatusCallback Pointer to a function to call while moving, pass a NULL for no callbacks Returns: True/False if the move was successful Implements IdeFileSystem. Reimplemented in deFSReal, and deFSVirtual.

IdeFile * deFileSystem::Open (  const char *    Filename, long    OpenFlags )  [virtual]

Open a file Parameters: in]  Filename Filename to open in]  OpenFlags flags for opening the filesystem deFile_Open_Create Create a file, fail if it exists deFile_Open_Existing Open an existing file, fail it if does not exist deFile_Open_Always Always open the file, create if it does not exist or open existing deFile_Open_CreateAlways Always open the file, override if the file already exists Returns: Return a pointer to an IdeFile class if valid Implements IdeFileSystem. Reimplemented in deFSReal, and deFSVirtual.

deBoolean deFileSystem::Rename (  const char *    OldFilename, const char *    NewFilename )  [virtual]

Rename a file Parameters: in]  OldFilename Original file to rename in]  NewFilename New name for the file Returns: True/False if the rename was successful Implements IdeFileSystem. Reimplemented in deFSReal, and deFSVirtual.

deBoolean deFileSystem::SetDirectory (  const char *    Directory )  [virtual]

Set the current directory. Implements IdeFileSystem. Reimplemented in deFSReal, and deFSVirtual.

---

The documentation for this class was generated from the following files:

• deFileSystem_priv.hpp
• deFileSystem.cpp

---